Un-ossify the build system #36
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
.dockerignore
Outdated
There was a problem hiding this comment.
This is similar to a gitignore file and tells the docker runtime to leave all of these files/folders out of the build context. It means we can simplify the dockerfile.
| @@ -1,30 +1,15 @@ | |||
| ARG BASE_IMAGE=node:18-alpine3.18 | |||
| ARG BASE_IMAGE=node:22-alpine | |||
There was a problem hiding this comment.
Get to the most recent LTS
| COPY ./package.json . | ||
| COPY ./yarn.lock . | ||
| COPY ./playground-ui ./playground-ui | ||
| COPY ./spicedb-common ./spicedb-common | ||
| COPY ./playground/package.json ./playground/package.json | ||
| # Bring in everything not ignored by the dockerignore | ||
| COPY . . |
There was a problem hiding this comment.
Don't need to be specific when we have dockerignore
| ENV YARN_CACHE_FOLDER=/tmp/yarn_cache | ||
| RUN yarn install --frozen-lockfile --production --non-interactive --network-timeout 1000000 | ||
| RUN yarn install --frozen-lockfile --non-interactive --network-timeout 1000000 |
There was a problem hiding this comment.
We explicitly want dev dependencies in the build process - otherwise we're leaving out things like typescript and our bundler.
| RUN npm install -g jshint | ||
| COPY ./playground/contrib/generate-config-env.sh . | ||
| COPY ./playground/contrib/test-config-env.sh . | ||
| RUN ./test-config-env.sh | ||
| RUN echo 'Config Verified' > verified |
There was a problem hiding this comment.
Config isn't used anymore.
There was a problem hiding this comment.
I got tests working with Vitest, which is faster and less janky than Jest. Vitest has you import the testing functions rather than treating them as implicit globals, so all test files have these changes.
| const possibleObjectTypes = []; | ||
| possibleObjectTypes.push(...resourceTypes); | ||
| possibleObjectTypes.push(...subjectTypes); | ||
| const possibleObjectTypes = [ |
There was a problem hiding this comment.
This fixed a typescript issue.
|
|
||
| describe("parsing validation YAML", () => { | ||
| it("returns undefined for an empty file", () => { | ||
| expect(parseValidationYAML("")).toEqual({ | ||
| message: "data must be object", | ||
| message: "data should be object", |
There was a problem hiding this comment.
I'm guessing these tests stopped passing on a recent SpiceDB wasm upgrade, but we don't run the tests in CI so we missed it. I'm going to enable tests as a follow-on to this.
| @@ -0,0 +1,17 @@ | |||
| /// <reference types="vite/client" /> | |||
|
|
|||
| interface ImportMetaEnv { | |||
There was a problem hiding this comment.
This makes typescript happier about import.meta.env variables and acts as a listing of the environment variables used in the application.
| plugins: [react(), svgr(),], | ||
| build: { | ||
| // This matches Vercel's expectations. | ||
| outDir: "build", |
There was a problem hiding this comment.
Vite defaults to putting things in dist, so we modify that here so that we don't have to muck with Vercel settings.
vercel.json
Outdated
| { | ||
| "source": "/s/:path([^/]+)/download", | ||
| "headers": [ | ||
| { | ||
| "key": "Content-Security-Policy", | ||
| "value": "frame-ancestors 'self' docs.authzed.com authzed.com www.authzed.com;" | ||
| } | ||
| ] | ||
| }, |
README.md
Outdated
There was a problem hiding this comment.
For docker builds, add note to specify all the env vars or add default values to the dockerfile
README.md
Outdated
There was a problem hiding this comment.
Remove the NODE_OPTIONS line from the vercel deploy option section (line 61) and node option (line 76).
Update instructions in the "Running for development" section
Dockerfile
Outdated
|
|
||
| COPY ./playground ./playground | ||
| # App environment variables | ||
| ENV VITE_AUTHZED_DEVELOPER_GATEWAY_ENDPOINT |
There was a problem hiding this comment.
These env vars can all be defaulted to empty string
Description
This escalated quickly. Roughly: I started by just wanting to collapse the workspaces. In moving the yarn lockfiles around, I triggered an upgrade of one package or another, which moved to ESM, which the create-react-app version of Webpack wasn't able to parse. You're kinda stuck with what CRA gives you as far as versions of things go.
That prompted a move to Vite, which shouldn't have been that destructive a change, except that we were doing a bunch of non-standard stuff. I had to fix a bunch of typescript issues that came with the new typescript version, which also included upgrading how we're doing protobuf generation. I also simplified the build process as much as I could by moving things into the
publicdir and letting vite copy them around.Changes
I'm gonna annotate this to call out the most relevant bits.
Testing
See that things are green and check out the preview to see that it works as desired.